close   


DokuwikiFCK is no longer being supported.
It has been superceded by fckgLite and ckgedit.
close   
namespace:
close   
All questions, bug fixes, and feature requests should go through the mailing list. To subscribe to the list, do one of the following:

1. Send an email to fckglite-request@freelists.org with 'subscribe' in the Subject field
2. Visit the fckgLite page at http://www.freelists.org/list/fckglite
3. Or click the subscribe link below

Subscribe
 

Configuration

fckgLite has several configuration settings which are set in the Configuration Manager. ('Starting Versions & Dates' for options 4-9 refer to an earlier versioning system: xx.xx-year-Month_day-minute_second.)

Setting Default Value Starting Versions & Dates
1. guest_toolbar Display Toolbar to Gueststrue
2. guest_media Guest Can Link to Media Filestrue
3. open_upload Guests can uploadfalse
4. xcl_plugins Immutable Syntax pluginsfckg_dwplugin01.02-09-Dec_24-10_49
5. default_fb Default File Browsing Accessacl01.03-10-Jan_01-10_35
6. openfbOpen File Browsingfalse01.03-10-Jan_01-10_35
7. CSRF (removed, see note)false02.03-Jan_16-09_53, 03.03
8. dw_edit_displayall02.03,03.03_10-Apr-12-08_49
9. smiley_as_textfalsefrom 8 May 2010
10. editor_bak Save backup on Refreshfalsefrom Sep 10 2010
11. create_folder Enable folder creationnfrom Sep 10 2010
12. dwedit_ns Namespaces where DokuWiki Editor is activatednonefrom Feb 26 2011
13. acl_delfalsefrom Mar 24 2011
14. auth_ci User login id is case insensitivefalsefrom May 7 2011
15. nix_stylefalsefrom Nov 24 2011
16 no_symlinksfalsefrom Nov 24 2011
17 directionnocheckfrom Apr 21 2012
18 scaytonfrom June 7 2012
19 scayt_autoonfrom June 7 2012
20 scayt_langAmerican Englishfrom June 7 2012
21 smiley_hackfalsefrom August 28 2012
22 complex_tablesfalsefrom Sep 13 2012
23 duplicate_notesfalsefrom Mar 12 2013
24 winstylefalseckgedit(2013/22/5),fckgLite(2014/1/4)
25 other_langdefaultckgedit June 14
26 dw_priorityfck/ckeditorFeb 8 2014
27 preload_ckeditorjsfalseJuly 14 2014


Notes

1-3. The default settings allow guests to have access to the toolbars and to the link and image tools. However, guests cannot upload, unless 3 is set to true. Setting 3 to true could be used to implement a completely open wiki, where anyone can edit and upload.(See below “What is a guest?”)

If “Display Toolbar to Guests” is set to false (checkbox unticked), guests are presented with a toolbar consisting of two items, About and Source.

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.

4. A comma delimited list of plugins the output of which is meant to become a permanent part of the page. This setting applies to plugins which use standard Dokuwiki markup. See the features page for additional details.

5. The file browser is acl-compliant, but the administrator can turn off acl by changing this option to 'none'

6. 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.

7. Check the csrf check-box if you get a CSRF alert. This occurs on some servers, because fckgLite creates its own Session, which runs parallel to the Dokuwiki Session. Dokuwiki may sometimes mistakenly interpret this second session as a Cross-site request forgery, which is an exploit that sends unauthorized commands to the server. Note: This option was removed 4 Nov 2010 when the fckgLite session was merged with the Dokuwiki session.

8. 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.

9. This governs how Dokuwiki smileys appear in the editor window. At the initial insertion, they appear as text but after the first save they appear as images. 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.

10. If set to true (checkbox checked), 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 an .fckg extension.

11. If set to 'y', a folder creation button will appear at the bottom of the fle browser. Folder cannot be created by guests. Included but has no effect in the 0 distribution, which always has folder creation enabled.

12. A comma separated list of namespaces where the Dokuwiki editor is automatically loaded instead of the FCKeditor. This will work with pagenames as well. The code looks only for partial matches. So if you have “jack”, it will find “blackjack” and “jack_pine”.

13. 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. This option enables the administrator make deletes consistent with the Dokuwiki practice.

14. User login id is case insensitive, that is you can login as both USER and user.

15. For Windows Servers (Vista and Later). This setting makes it possible to access data\media through fckg\fckeditor\userfiles, if links to media and file have been successfully created in userfiles. See the auto install document. Thisoption is helpful in some cases where the savedir has been moved.

16. Disable automatic creation of symbolic links in fckg/userfiles. This setting applies to installations, where fckgLite attempts to create symlinks. See the auto install document.

17. This option controls the language direction in the FCKeditor. 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.

18. When set to “on” (default) the SCAYT spell checker is active. When set to “off” the standard “Spellerpages” checker is used. SCAYT checks as you type, Spellerpages checks only when the spell-check toolbar button is clicked.

19. When set to “on” the SCAYT spell checker is immediately active when the editing window is opened. When set to “off”, you have to click on the spell-check toolbar button and select “enable SCAYT” to make SCAYT active.

20. This is a drop-down list of available languages. The default language is American English.

21. This option applies only to the FCKeditor smileys, not the native Dokuwik 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 faq on smileys.

22. This turns on the complex tables parser, aimed at tables that use multiple column and row spans. As it becomes more widely used, it will supplant the default parsing of tables. It should prove to be much more robust and more accommodating of features and plugins that the default sometimes balks at. Currently it is available only in the complex tables distributions. On github this is the ctable branch. It is also possible to turn on the complex tables parse on a per page basis by placing the ~~COMPLEX_TABLES~~ macro at the top of the page. See :features

23. When Dokuwiki encounters footnotes with identiical 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

fckgLite 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. In the editor each of these footnotes will appear on a separate line, but when in the browser, they will appear as above.

24. On linux systems, data/media is normally accessed through symbolic links in fckeditor/userstyles, which link to data/media. This option gives direct access to data/media. In order for it to work with apache servers, you must copy .htaccess.security from fckeditor/userfiles to data/media and rename it .htaccess. The reason for this is that Dokuwiki by default prevents direct access to your data. .htaccess.security relaxes this restriction with respect to the basic image formats: .gif, .jpg, .png. See security_and_the_media_directory.

25. Select interface language for CKEditor: defaults to language set for browser. This choice is independent of the Dokuwiki interface language option.

26. By default, both ckgedit and fckgLite open with their respective WYSIWG editors. 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.

27. 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.

What is a guest?

A guest is determined in one of two ways.

  1. The user is registered and has been assigned to the “guest” group
  2. The person is a visitor to the site and clicks on the “Show pagesource” button. In this case the page will display in an FCKeditor editing window, with a toolbar at the top of the window. Unless yours is an open wiki to which anyone can contribute, the page will be “read only”.

Configuring aspell for use in the FCKeditor's spell checker

Unix type systems

The spell checker requires installation of aspell and the relevant dictionaries need for your site. Modern Linux systems come with aspell already installed. If it isn't on yours, you can use yum to install it or the system's package manager. On Centos the package manager will get all dictionaries as well. Lacking these facilities you can go to the Gnu aspell web site at http://aspell.net/ and download the required packages, which come with installation instructions. On OS X you can use macports or Fink to install the required software. Once these packages are installed there is nothing else to do.

Windows

The spell checker is set up to auto-detect the operating system in the file:

  • fckg/fckeditor/is_aspellWindows.php

That file also contains the default location for the aspell executable, which appears at the top of the file:

  • $aspell_win = '“C:\Program Files\Aspell\bin\aspell.exe” ';

If this is not correct, then you will have to change it to the correct path.

For distributions of fckgLite which are older than February 2010, see the document on installing aspell for windows.

Configuring the Editor Window for Alternate Templates

The editor is configured as much as possible to accommodate the default Dokuwiki template. If you want to configure it to accommodate other templates, you can do this in fck_editorarea.css, which you will find in /fckg/fckeditor/editor/css. If you want to control the position of the editing window, you might consulte the following post from the fckgLite mailing list: http://www.freelists.org/post/fckglite/Move-fckeditor-box,1.

The new Dokuwiki Template

Beginning with Adora Belle, Dokuwiki comes with the dokuwiki template as its default template, whereas the old default template is still labeled as default. fckgLite comes with two style sheets for the editor, one for the 'dokuwik'i template and one for the old 'default'. These are found in lib/plugins/fckg/fckeditor/editor/css:

  • fck_editorarea.css.default_template
  • fck_editorarea.css.dokuwiki_template

The currently active style sheet is named fck_editorarea.css. So, if you are using the 'default' template, then you should rename fck_editorarea.css.default_template to fck_editorarea.css. The same goes for any other style sheet which you might want to implement for a third-party template.

Configuring the File Browser

Version 0.02 and all subsequent packages include an auto-configuration feature which should handle the installation of the media browser on both Unix-type and Windows systems. For any problems with the media browser, see the the document on installing the file browser.

For instructions on using the file browser go to the media page.

Language Support

Editing Window

You can change the language of the editing and navigation buttons that are specific to fckgLite and are not recognized by Dokuwiki. To implement language support for your language you must add a language file to fckg/action/lang the name of which has the form <lang>.php. So English is en.php, German de.php, etc. Use en.php as your template. The labels are defined in an array named $fckg_lang. If you do not define a particular label, the label defaults to its English name. You can use the English language version of this file for your template.

RTL Support

fckgLite added rtl support for the FCKeditor editing window in April 2012. The language direction of the editing window can be configured independently of the browser's or of Dokuwiki's language direction. See configuration option number 17 (above).

FCKeditor Toolbar

tags:

Language Detection

The FCKeditor is set up to auto-detect the current language. However the autodetection may fail, and if it does you will have to set your language manually. This is done in the file fckg/fckeditor/fckconfig.js. At approximately line 60 you will find the following settings:

FCKConfig.AutoDetectLanguage    = true ;
FCKConfig.DefaultLanguage       = 'en' ;

Set FCKConfig.AutoDetectLanguage false and FCKConfig.DefaultLanguage to your own language code (the language codes are explained in the following paragraph). So, if your language is German, you would have:

FCKConfig.AutoDetectLanguage    = false ;
FCKConfig.DefaultLanguage       = 'de' ;

Javacript Language Files

The main language files for the FCKeditor are in fckg/fckeditor/editor/lang. These are all javascript files, with the extension .js. Each file name is taken from its two-character ISO_639-1 code. So English is en.js, Spanish es.js, German de.js, etc. These files contain all of the translations that come with the default installation FCKeditor. But fckgLite has number of modifications and additions to the default installation, and for these you will have to update your language file.

The translations that have to be made for fckgLite are contained in the file fckg/fckeditor/editor/lang/language-template.txt, a copy of which is here. You update your language file by adding the new translations to your current language file. You can simply append them to the bottom of the file.

We have found that certain labels for the plugin tool do not appear in the selected language but instead show up in English. If this happens, you can create a language file for the plugin tool. This file goes in the plugin tool's language directory, which is fckg/fckeditor/editor/plugins/plugintool/lang. There you will find a number of other language files, which are named like the main language files, en.js, de.js, etc. Use one of these files as the template for your own language. There is no conflict if you have installed translations in the main language file and then also have the separate file installed in the plugin tool's lang directory.

After you have installed your language file in the plugin tool's language directory, you must notify the FCKeditor that it exists. Again, you update fckconfig.js. At about line 106 you will find FCKConfig.Plugins.ADD, to which you append your language code. It already includes several languages which have files included in the plugin tool's lang directory. So, if your language is Spanish, you would have this:

 FCKConfig.Plugins.Add('plugintool', 'en,fr,nl,de,es') ;

HTML Entities

For some non-Roman characters, for Latin characters with accents, and for assorted symbols, the FCKeditor uses HTML entities. For instance À – the capital A with a grave accent – will be represented as &Aagrave; whereas Dokuwiki saves such characters as is, in their original form. These character entities have to be converted back to the originals before being saved to the DOkuwiki text files, otherwise they will be lost. The file which governs these conversions is called ent.ser and is found in fckg/action. If you need a character which is not found in ent.ser, you can you can add to it as described in the ENTITIES.HOWTO file which you will find in fckg/action/entities.

For additional information on how to deal with certain Dokuwiki entities, see playground:entities in the fckgLite documentation.