| * Easy to Use
|
| * Source Code View
|
|
|
| -^__NOTE:__ ))FCKEditor(( is currently NOT compatible with the Ajax Comments feature in LibertyPackage.^
|
| +! Toolbars |
| +Bitweaver includes the ability to use one of several toolbars with FCKeditor easily. It is also possible to customize the toolbar by editing the fckeditor/jscripts/fckconfig.js file to specify your own and then adding it to fckeditor/admin/))admin_fckeditor_inc((.php. |
|
|
| -!Toolbars
|
| -Bitweaver includes the ability to use one of several toolbars with ))FCKEditor(( easily. It is also possible to customize the toolbar by editing the fckeditor/jscripts/fckconfig.js file to specify your own and then adding it to fckeditor/admin/))admin_fckeditor_inc((.php.
|
| +! Skins |
| +Bitweaver includes the ability to skin the interface with one of the three default skins. It is also possible to create your own skin. You will have to add it to the fckeditor/admin/))admin_fckeditor_inc((.php file to add it to the administration interface. |
|
|
| -!Skins
|
| -Bitweaver includes the ability to skin the interface with one of the three default skins. It is also possible to create your own skin. You will have to add it to the fckeditor/admin/admin_fckeditor_inc.php file to add it to the administration interface.
|
| +! Issues |
| +* __FCKeditor is currently NOT compatible with the feature ''Ajax Comments'' in -+Admin > Liberty > Comments+-.__ |
|
|
| -!Adding Your Own Features/Plugins
|
| -Here are two good tutorials to get you started
|
| -[http://sourceforge.net/forum/forum.php?thread_id=1268047&forum_id=257180|Create a Dialog Based Plug-In]
|
| -[http://sourceforge.net/forum/message.php?msg_id=3091867|Creating a Non-dialog Based Plugin ]
|
| +! Your own plugins for FCKeditor |
| +If you want to write your own plugin for FCKeditor, here are two good tutorials to get you started: |
| +* [http://wiki.fckeditor.net/Developer's_Guide/Customization/Plug-ins|Creating & Installing a Plugin in FCKeditor] (How-to from FCKeditor's Wiki at fckeditor.net) |
| +* [http://sourceforge.net/forum/message.php?msg_id=3091867|Creating a Non-dialog Based Plugin] (Step-by-step guide in FCKeditor's forum at sourceforge.net) |
|
|
| +! Bitweaver's plugins for FCKeditor |
|
|
| -!bitweaver Plugins for FCKeditor
|
| +!! Split |
| +The Split plugin gives you a button that will insert a split tag: ...split... into your content. This is good for blog posts and articles where you want to easily define a read more section. Now your users don't need to know how to use ...split... they can just click the "Insert Split" button, which includes a hover tool tip letting you know it is for adding a Read More section. To enable Split in your FCKeditor, open the file __fckconfig.js__ and uncomment the following line: |
|
|
| -!!Split
|
| -The Split plugin gives you a button that will insert a split tag: ...split... into your content. This is good for blog posts and articles where you want to easily define a read more section. Now your users don't need to know how to use ...split... they can just click the "Insert Split" button, which includes a hover tool tip letting you know it is for adding a Read More section.
|
| -
|
| -To enable Split in your FCKeditor you need to edit your fckconfig.js file in fckeditor/jscripts/
|
| -
|
| -In fckconfig.js you need to add/uncomment the following:
|
| -{code}
|
| +{code title="/fckeditor/jscripts/fckconfig.js"} |
| FCKConfig.Plugins.Add( 'split' ) ;
|
| {/code}
|
|
|
| -and you need to add Split to your toolbar list, for example like:
|
| -{code}
|
| +Now you need to add Split to your toolbar list, for example like: |
| +{code title="/fckeditor/jscripts/fckconfig.js"} |
| FCKConfig.ToolbarSets["Basic"] = [
|
| ['Source'],['Bold','Italic','-','OrderedList','UnorderedList','-','Link','Unlink','-','Split']
|
| ] ;
|
| {/code}
|
|
|
| -!!Attachment
|
| -The Attachment plugin integrates bitweaver's native LibertyAttachments features into the FCKeditor. __Note that the current state of the Attachment plugin only supports previewing of images, and does not yet create attachment associations between content and uploaded files.__ Like the attachment tab in most liberty content packages this fck plugin will let you upload files via ajax to associate with your user account. You can also get a list of all attachments your user has ever uploaded. From the resulting list it is a single click to insert attachment code into your text. The fck plugin will also preview the attachment image in the fck editing interface.
|
| +!! Attachment |
| +The Attachment plugin integrates bitweaver's native LibertyAttachments features into the FCKeditor. __Note that the current state of the Attachment plugin only supports previewing of images, and does not yet create attachment associations between content and uploaded files.__ Like the attachment tab in most liberty content packages this FCKeditor plugin will let you upload files via Ajax to associate with your user account. You can also get a list of all attachments your user has ever uploaded. From the resulting list it is a single click to insert attachment code into your text. The FCKeditor plugin will also preview the attachment image in the FCKeditor editing interface. To enable Attachment in your FCKeditor you need to edit __fckconfig.js__ and FCKeditor's __))header_inc((.tpl__: |
|
|
| -To enable Attachment in your FCKeditor you need to edit your fckconfig.js file in fckeditor/jscripts/ and edit the fck ))header_inc((.tpl
|
| -
|
| -In fckconfig.js you need to add/uncomment the following:
|
| -{code}
|
| +{code title="/fckeditor/jscripts/fckconfig.js"} |
| +// add or uncomment: |
| FCKConfig.Plugins.Add( 'attachment' ) ;
|
| {/code}
|
|
|
| -and you need to add Attachment to your toolbar list, for example like:
|
| -{code}
|
| +Now you need to add Attachment to your toolbar list, for example like: |
| + |
| +{code title="/fckeditor/jscripts/fckconfig.js"} |
| FCKConfig.ToolbarSets["Basic"] = [
|
| ['Source'],['Bold','Italic','-','OrderedList','UnorderedList','-','Link','Unlink','-','Attachment']
|
| ] ;
|
| {/code}
|
|
|
| -In header_inc.tpl you need to include a number of the MochiKit javascript library files.
|
| -{code}
|
| +Finally, include a number of the ))MochiKit(( Javascript library files, there are two ways to do this. You can add them in the header_inc.tpl or even better is to edit bit_setup_inc.php and include them via our javascript bundling function: |
| + |
| +{code title="/fckeditor/templates/header_inc.tpl"} |
| {if $gBitSystem->isPackageActive('fckeditor') }
|
| <script src="../util/javascript/libs/MochiKit/Base.js" type="text/javascript"></script>
|
| <script src="../util/javascript/libs/MochiKit/Iter.js" type="text/javascript"></script>
|
| <script src="../util/javascript/libs/MochiKit/Async.js" type="text/javascript"></script>
|
|
|
| -...rest of header code
|
| +... rest of header code |
| {/if}
|
| {/code}
|
|
|
| -!Image Browser Fix
|
| -To get the Resources Browser (Image > Browse Server) working so you can upload files,flash,images and media follow the steps below
|
| +{code title="/fckeditor/bit_setup_inc.php"} |
| + $gBitThemes->loadAjax( 'mochikit', array( 'Iter.js' ) ); |
| + // add the above loadAjax call before the following loadJavascript line |
| + $gBitThemes->loadJavascript( FCKEDITOR_PKG_PATH.'jscripts/fckeditor.js' ); |
| +{/code} |
|
|
| -in jscripts/editor/fckconfig.js
|
| -change asp
|
| -{code}
|
| - var _FileBrowserLanguage = 'asp' ;
|
| - var _QuickUploadLanguage = 'asp' ;
|
| +! Image Browser Fix |
| +To get the Resources Browser (Image > Browse Server) working so you can upload files, flash, images and media, first change 'asp' to 'php' in __fckconfig.js__: |
| + |
| +{code title="/fckeditor/jscripts/editor/fckconfig.js"} |
| +// original: |
| +// var _FileBrowserLanguage = 'asp' ; |
| +// var _QuickUploadLanguage = 'asp' ; |
| +// change to: |
| +var _FileBrowserLanguage = 'php' ; |
| +var _QuickUploadLanguage = 'php' ; |
| {/code}
|
| -to php
|
| -{code}
|
| - var _FileBrowserLanguage = 'php' ;
|
| - var _QuickUploadLanguage = 'php' ;
|
| + |
| +Now create new directories in your storage directory: |
| + |
| +{code title="new directories"} |
| +/storage/Image/ |
| +/storage/Media/ |
| +/storage/Flash/ |
| +/storage/File/ |
| {/code}
|
|
|
| -create the following directories in your storage directory
|
| -Image,Media,Flash,File
|
| +Now edit the __config.php__ of FCKeditor's Filemanager: |
|
|
| -in jscripts/editor/filemanager/browser/default/connectors/php/config.php
|
| -change
|
| -{code}
|
| - $Config['Enabled'] = false;
|
| -{/code}
|
| -to
|
| -{code}
|
| +{code title="/fckeditor/jscripts/editor/filemanager/browser/default/connectors/php/config.php"} |
| +// original: |
| +// $Config['Enabled'] = false; |
| +// change to: |
| $Config['Enabled'] = true;
|
| -{/code}
|
|
|
| -also set
|
| -{code}
|
| - $Config['UserFilesPath'] = "/UserFiles/";
|
| -{/code}
|
| -to point to your storage directory or any other directory that you want your media to be stored in.
|
| -{code}
|
| +// original: |
| +// $Config['UserFilesPath'] = "/UserFiles/"; |
| +// change to: |
| +// your storage directory or any other directory that you want your media to be stored in. |
| $Config['UserFilesPath'] = "/bitweaver/storage/";
|
| {/code}
|
|
|
| -make sure apache can write to the directories you created above
|
| -{code}
|
| +Make sure apache can write to the directories you created above: |
| + |
| +{code title="command line"} |
| chmod -R 777 storage/
|
| {/code}
|
| -Now point your browser to your fckconfig.js file and hit reload
|
| -http://localhost/bitweaver/fckeditor/jscripts/fckconfig.js this just makes sure that your changes arn't cached in your browser
|
|
|
| +Now point your browser to __fckconfig.js__ (http://localhost/bitweaver/fckeditor/jscripts/fckconfig.js) and hit reload to makes sure that your changes are present in your browser. |
|
|
| -!Custom Configuration File
|
| -By setting up your ))FCKEditor(( with a custom config file, updates become less problematic, playing around with different settings becomes easier, and the overall setup becomes tidier:
|
|
|
| -{code}
|
| -1. copy /fckeditor/templates/header_inc.tpl to your theme folder:
|
| -2. /themes/styles/mytheme/fckeditor/header_inc.tpl
|
| -3. find a line like:
|
| -4. var oFCKeditor = something ;
|
| -5. write this underneath:
|
| -6. oFCKeditor.Config["CustomConfigurationsPath"] = "{$smarty.const.THEMES_PKG_URL}styles/mytheme/fckeditor/fckconfig.js";
|
| -7. you might also want this next extra line for ultra-fine-control over the toolbar:
|
| -8. oFCKeditor.ToolbarSet = "finetunedtoolbar";
|
| -{/code}
|
| +! Custom configuration files |
| +Set up your FCKeditor with a __custom fckconfig.js__ to make updates and trying different settings easier: |
| +# Admin > FCKeditor > Settings: |
| +# enable ''Custom config file'' |
| +# copy /fckeditor/fckconfig.bitweaver.js to your custom style: |
| +# /themes/styles/your-style/fckeditor/fckconfig.bitweaver.js |
| +# edit settings and toolbars, see: |
| +# [http://wiki.fckeditor.net/Developer%27s_Guide/Configuration/Configurations_Settings|FCKeditor documentation] |
| +# trick: externalize the XML file that holds FCKeditor's styles: |
| +## copy ''fckstyles.xml'' from /fckeditor/jscripts/fckstyles.xml to your custom style |
| +## in /themes/styles/your-style/fckeditor/fckconfig.bitweaver.js, add: |
| +## FCKConfig.StylesXmlPath = '/themes/styles/your-style/fckeditor/fckstyles.xml'; |
| +## by editing that file you can control which styles are shown in FCKeditor's style dropdown |
|
|
| -Now, of course, create the file fckconfig.js in the path mentioned above. This holds all the desired variables from [http://wiki.fckeditor.net/Developer%27s_Guide/Configuration/Configurations_Settings|their documentation pages]. Now if the ))FCKEditor(( package is updated, your settings are not lost. (Take it even one step further by externalizing that XML file. Copy the file fckstyles.xml from /fckeditor/jscripts/fckstyles.xml to the location claimed underneath, the content and how to utilize it is almost self-explanatory.) Anyway, for example, a fckconfig.js file might look like this:
|
|
|
| -{code}
|
| -FCKConfig.Plugins.Add( 'attachment' ) ;
|
| -FCKConfig.BodyClass = 'fck';
|
| -FCKConfig.EditorAreaCSS = '/themes/styles/mystyle/mystyle.css';
|
| -FCKConfig.ForceStrongEm = true;
|
| -FCKConfig.StylesXmlPath = '/themes/styles/mystyle/fckeditor/fckstyles.xml';
|
| -FCKConfig.ToolbarSets["finetunedtoolbar"] = [
|
| - ['Source','Style','PasteText','RemoveFormat','Undo','Redo','Bold','Italic','OrderedList','UnorderedList','Outdent','Indent'],
|
| - ['Link','Unlink','Table','SpecialChar','FitWindow','Attachment']
|
| -] ;
|
|
|
| -// for UTF-8 + Text Diff uncomment these 4 lines:
|
| -// FCKConfig.ProcessHTMLEntities = false;
|
| -// FCKConfig.IncludeLatinEntities = false;
|
| -// FCKConfig.IncludeGreekEntities = false;
|
| -// FCKConfig.ProcessNumericEntities = false;
|
| -{/code}
|
| +! How to prevent the FCKifying of certain textareas |
| +There are quite a few textareas that should not be FCKified even if the editor is supposed to be available in general. Examples would be the textarea to add trackback URLs to a blog posting and many of the kernel's textareas. To prevent the editor to hook on to your textareas, don't use bitweaver's "textarea" Smarty-plugin, but normal plain HTML: |
|
|
| -!UTF-8 + ))Text_Diff((?
|
| -If you're using the HTML format and also sometimes the ))WYSIWYG(( editor and still want to compare different versions of a Wiki page efficiently, you want ))Text_Diff((, the PEAR package that should be installed on your system. There are only 2 problems. First, to make ))Text_Diff(( work in a UTF-8 (e.g., non English) environment, you need to stop ))FCKEditor(( from processing special characters, otherwise ))Text_Diff(( will always find that Motörhead is something else than Motörhead. For that, the last 4 variables in that code sample above are ace of spades. Next, in /wiki/templates/))page_history((.tpl around line 40 you could change
|
| -{code title="/wiki/templates/page_history.tpl"}
|
| -this: {$diffdata}
|
| -to this: {$diffdata|html_entity_decode}
|
| +{code title="somepackage/templates/some.tpl"} |
| +{* |
| +// instead of: |
| +// {textarea id="someid" rows=6 help="somehelpnote"}{/textarea} |
| +// write: |
| +*} |
| + <textarea id="someid" rows=6 help="somehelpnote"></textarea> |
| {/code}
|
| -... which both can be desirable, but the latter version renders HTML, so that ))Text_Diff(('ing might not result in an exact view of all characters that have actually changed, but in a nicy-fied view of what ''content'' has actually changed:
|
| -
|
| -||before (normal plain text diff) | after (html enhanced diff)
|
| -{attachment id=790 size=medium} | {attachment id=791 size=medium}||
|
| -
|
| -! How to prevent the FCKifying of certain textareas
|
| -There are quite a few textareas that should not be FCKified even if the editor is supposed to be available in general. Examples would be the textarea to add trackback URLs to a blog posting and many of the kernel's textareas, as well as the ones you add yourself. To prevent the editor to hook onto those, use the __noformat="y"__ attribut like so:
|
| -{code}
|
| -{textarea id="someid" noformat="y" rows=6 help="somehelpnote"}{/textarea}
|
| -{/code}
|
| - |