Index: Keditor.Java/branches/2.4/src/site/apt/fckeditor-properties.apt =================================================================== --- /FCKeditor.Java/branches/2.4/src/site/apt/fckeditor-properties.apt (revision 1918) +++ (revision ) @@ -1,143 +1,0 @@ -~~ FCKeditor - The text editor for Internet - http://www.fckeditor.net -~~ Copyright (C) 2003-2008 Frederico Caldeira Knabben -~~ -~~ == BEGIN LICENSE == -~~ -~~ Licensed under the terms of any of the following licenses at your -~~ choice: -~~ -~~ - GNU General Public License Version 2 or later (the "GPL") -~~ http://www.gnu.org/licenses/gpl.html -~~ -~~ - GNU Lesser General Public License Version 2.1 or later (the "LGPL") -~~ http://www.gnu.org/licenses/lgpl.html -~~ -~~ - Mozilla Public License Version 1.1 or later (the "MPL") -~~ http://www.mozilla.org/MPL/MPL-1.1.html -~~ -~~ == END LICENSE == -~~ @version $Id$ - ------------------------------ - Configuration reference - ------------------------------ - -Configuration setting - - All properties are optional. In the meaning of 'Convention over Configuration' - only the properties, of which the default isn't requested, have to be set. - - There are two ways to overwrite the default properties: - - * By creating a <<>> file in the classpath (usually - <<>>): - -+-------------------------------------------------------+ - ... - fckeditor.toolbarSet=Silver - connector.userActionImpl=net.fckeditor.requestcycle.impl.UserActionImpl - ... -+-------------------------------------------------------+ - - * By calling dynamically the <<>> class: - -+-------------------------------------------------------+ - ... - import net.fckeditor.handlers.PropertiesLoader; - ... - PropertiesLoader.setProperty("fckeditor.toolbarSet", "Silver"); - PropertiesLoader.setProperty("connector.userActionImpl", - "net.fckeditor.requestcycle.impl.UserActionImpl"); - ... -+-------------------------------------------------------+ - - [Attention:] It is essential to know how to use the PropertiesHandler. Like - the common properties usage, you should use it only one time at - the start of your web application. If you don't have a kind of - an 'initialization'-servlet, where you could place the - PropertiesLoader calls we suggest to write your own - ServletContextListener. So you guarantee, you call the - PropertiesLoader after the ConnectorServlet is initialized. - - [] - - As you see, in both ways the name of the properties are equal. The tables below - lists all the configurable properties for the integration pack. - -Configuration properties - -* FCKeditor - -*------------------------------------+--------------------------------+-----------------------------+-----------------------------------+ -|| Property || Default || Valid Values || Description || -|| || || || || -*------------------------------------+--------------------------------+-----------------------------+-----------------------------------+ -| fckeditor.toolbarSet \ \ \ \ \ \ | Default | any string \ \ \ \ \ \ | Indicates the toolbar set you want to load. If you provide a name which does not exist, the editor will fail. | -*------------------------------------+--------------------------------+-----------------------------+-----------------------------------+ -| fckeditor.width | 200 | any string | Indicates the editor width. | -*------------------------------------+--------------------------------+-----------------------------+-----------------------------------+ -| fckeditor.height | 100% | any string | Indicates the editor height. | -*------------------------------------+--------------------------------+-----------------------------+-----------------------------------+ -| fckeditor.basePath | /fckeditor \ \ \ \ \ \ | any path | The default path of the editor installation resides within your webapp. | -| | | | Change this value only if you install the editor under a different name or maintain several editor installations. | -*------------------------------------+--------------------------------+-----------------------------+-----------------------------------+ - -* Connector - - The integration pack supports file, flash, image, and media resource types. - Replace in the property name with "file", "flash", "image", or - "media". - - Define <> an allowed <> denied list. If an allowed list is pre-defined - overwrite it with an empty list and define your denied list as you wish. - -*-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ -|| Property || Default || Valid Values || Description || -|| || || || || -*-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ -| connector.resourceType. | any path | Indicates the resource type path to retrieve and store files. | -| name>.path | | | | -*-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ -| connector.resourceType..extensions.denied | | | separate extensions with a \| (pipe symbol). | -*-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ -| connector.resourceType.file. | 7z\|aiff\|asf\|avi\|bmp\|csv\| | any extension | List with extensions which should be allowed. | -| extensions.allowed | doc\|fla\|flv\|gif\|gz\|gzip\| | | separate extensions with a \| (pipe symbol). | -| | jpeg\|jpg\|mid\|mov\|mp3\|mp4\|| | | -| | mpc\|mpeg\|mpg\|ods\|odt\|pdf\|| | | -| | png\|ppt\|pxd\|qt\|ram\|rar\| | | | -| | rm\|rmi\|rmvb\|rtf\|sdc\|sitd\|| | | -| | swf\|sxc\|sxw\|tar\|tgz\|tif\| | | | -| | tiff\|txt\|vsd\|wav\|wma\|wmv\|| | | -| | xls\|xml\|zip | | | -*-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ -| connector.resourceType.flash. | swf\|fla | any extension | See above. | -| extensions.allowed | | | | -*-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ -| connector.resourceType.image. | bmp\|gif\|jpeg\|jpg\|png | any extension | See above. | -| extensions.allowed | | | | -*-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ -| connector.resourceType.media. | aiff\|asf\|avi\|bmp\|fla\|flv\|| any extension | See above. | -| extensions.allowed | gif\|jpeg\|jpg\|mid\|mov\|mp3\|| | | -| | mp4\|mpc\|mpeg\|mpg\|png\|qt\| | | | -| | ram\|rm\|rmi\|rmvb\|swf\|tif\| | | | -| | tiff\|wav\|wma\|wmv | | | -*-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ -| connector.userFilesPath | /userfiles | any path | Indicates the path where files are stored. | -*-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ -| connector.forceSingleExtension| true | true, false (boolean) | Indicates whether file names with multiple extensions are sanitzed.| -*-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ -| connector.fullUrl | false | true, false (boolean) | Indicates whether the server url will be prepended.| -| | | | I.e. appending http://www.yourdomain.com/ | -*-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ -| connector.secureImageUploads |true | true, false (boolean) | Checks uploaded images for validity. | -| | | | I.e. the uploaded file is a real image not any | -| | | | other renamed file type. | -*-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ -| connector.userActionImpl | | any class implementing the | Providing custom security functions for the File | -| | | {{{java-core/apidocs/net/fckeditor/requestcycle/UserAction.html}<<>>}} | Browser Connector. For more details see | -| | | interface | {{{integration/connector.html#Extending_the_Connector}Extending the Connector}}. | -*-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ -| connector.userPathBuilderImpl | | any class implementing the | Providing a custom function to construct an user depended 'BaseDir' for the | -| | | {{{java-core/apidocs/net/fckeditor/requestcycle/UserPathBuilder.html}<<>>}} | Browser Connector. For more details see | -| | | interface | {{{integration/connector.html#Extending_the_Connector}Extending the Connector}}. | -*-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ Index: /FCKeditor.Java/branches/2.4/src/site/apt/properties.apt =================================================================== --- /FCKeditor.Java/branches/2.4/src/site/apt/properties.apt (revision 1919) +++ /FCKeditor.Java/branches/2.4/src/site/apt/properties.apt (revision 1919) @@ -0,0 +1,143 @@ +~~ FCKeditor - The text editor for Internet - http://www.fckeditor.net +~~ Copyright (C) 2003-2008 Frederico Caldeira Knabben +~~ +~~ == BEGIN LICENSE == +~~ +~~ Licensed under the terms of any of the following licenses at your +~~ choice: +~~ +~~ - GNU General Public License Version 2 or later (the "GPL") +~~ http://www.gnu.org/licenses/gpl.html +~~ +~~ - GNU Lesser General Public License Version 2.1 or later (the "LGPL") +~~ http://www.gnu.org/licenses/lgpl.html +~~ +~~ - Mozilla Public License Version 1.1 or later (the "MPL") +~~ http://www.mozilla.org/MPL/MPL-1.1.html +~~ +~~ == END LICENSE == +~~ @version $Id$ + ------------------------------ + Configuration reference + ------------------------------ + +Configuration setting + + All properties are optional. In the meaning of 'Convention over Configuration' + only the properties, of which the default isn't requested, have to be set. + + There are two ways to overwrite the default properties: + + * By creating a <<>> file in the classpath (usually + <<>>): + ++-------------------------------------------------------+ + ... + fckeditor.toolbarSet=Silver + connector.userActionImpl=net.fckeditor.requestcycle.impl.UserActionImpl + ... ++-------------------------------------------------------+ + + * By calling dynamically the <<>> class: + ++-------------------------------------------------------+ + ... + import net.fckeditor.handlers.PropertiesLoader; + ... + PropertiesLoader.setProperty("fckeditor.toolbarSet", "Silver"); + PropertiesLoader.setProperty("connector.userActionImpl", + "net.fckeditor.requestcycle.impl.UserActionImpl"); + ... ++-------------------------------------------------------+ + + [Attention:] It is essential to know how to use the PropertiesHandler. Like + the common properties usage, you should use it only one time at + the start of your web application. If you don't have a kind of + an 'initialization'-servlet, where you could place the + PropertiesLoader calls we suggest to write your own + ServletContextListener. So you guarantee, you call the + PropertiesLoader after the ConnectorServlet is initialized. + + [] + + As you see, in both ways the name of the properties are equal. The tables below + lists all the configurable properties for the integration pack. + +Configuration properties + +* FCKeditor + +*------------------------------------+--------------------------------+-----------------------------+-----------------------------------+ +|| Property || Default || Valid Values || Description || +|| || || || || +*------------------------------------+--------------------------------+-----------------------------+-----------------------------------+ +| fckeditor.toolbarSet \ \ \ \ \ \ | Default | any string \ \ \ \ \ \ | Indicates the toolbar set you want to load. If you provide a name which does not exist, the editor will fail. | +*------------------------------------+--------------------------------+-----------------------------+-----------------------------------+ +| fckeditor.width | 200 | any string | Indicates the editor width. | +*------------------------------------+--------------------------------+-----------------------------+-----------------------------------+ +| fckeditor.height | 100% | any string | Indicates the editor height. | +*------------------------------------+--------------------------------+-----------------------------+-----------------------------------+ +| fckeditor.basePath | /fckeditor \ \ \ \ \ \ | any path | The default path of the editor installation resides within your webapp. | +| | | | Change this value only if you install the editor under a different name or maintain several editor installations. | +*------------------------------------+--------------------------------+-----------------------------+-----------------------------------+ + +* Connector + + The integration pack supports file, flash, image, and media resource types. + Replace in the property name with "file", "flash", "image", or + "media". + + Define <> an allowed <> denied list. If an allowed list is pre-defined + overwrite it with an empty list and define your denied list as you wish. + +*-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ +|| Property || Default || Valid Values || Description || +|| || || || || +*-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ +| connector.resourceType. | any path | Indicates the resource type path to retrieve and store files. | +| name>.path | | | | +*-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ +| connector.resourceType..extensions.denied | | | separate extensions with a \| (pipe symbol). | +*-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ +| connector.resourceType.file. | 7z\|aiff\|asf\|avi\|bmp\|csv\| | any extension | List with extensions which should be allowed. | +| extensions.allowed | doc\|fla\|flv\|gif\|gz\|gzip\| | | separate extensions with a \| (pipe symbol). | +| | jpeg\|jpg\|mid\|mov\|mp3\|mp4\|| | | +| | mpc\|mpeg\|mpg\|ods\|odt\|pdf\|| | | +| | png\|ppt\|pxd\|qt\|ram\|rar\| | | | +| | rm\|rmi\|rmvb\|rtf\|sdc\|sitd\|| | | +| | swf\|sxc\|sxw\|tar\|tgz\|tif\| | | | +| | tiff\|txt\|vsd\|wav\|wma\|wmv\|| | | +| | xls\|xml\|zip | | | +*-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ +| connector.resourceType.flash. | swf\|fla | any extension | See above. | +| extensions.allowed | | | | +*-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ +| connector.resourceType.image. | bmp\|gif\|jpeg\|jpg\|png | any extension | See above. | +| extensions.allowed | | | | +*-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ +| connector.resourceType.media. | aiff\|asf\|avi\|bmp\|fla\|flv\|| any extension | See above. | +| extensions.allowed | gif\|jpeg\|jpg\|mid\|mov\|mp3\|| | | +| | mp4\|mpc\|mpeg\|mpg\|png\|qt\| | | | +| | ram\|rm\|rmi\|rmvb\|swf\|tif\| | | | +| | tiff\|wav\|wma\|wmv | | | +*-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ +| connector.userFilesPath | /userfiles | any path | Indicates the path where files are stored. | +*-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ +| connector.forceSingleExtension| true | true, false (boolean) | Indicates whether file names with multiple extensions are sanitzed.| +*-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ +| connector.fullUrl | false | true, false (boolean) | Indicates whether the server url will be prepended.| +| | | | I.e. appending http://www.yourdomain.com/ | +*-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ +| connector.secureImageUploads |true | true, false (boolean) | Checks uploaded images for validity. | +| | | | I.e. the uploaded file is a real image not any | +| | | | other renamed file type. | +*-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ +| connector.userActionImpl | | any class implementing the | Providing custom security functions for the File | +| | | {{{java-core/apidocs/net/fckeditor/requestcycle/UserAction.html}<<>>}} | Browser Connector. For more details see | +| | | interface | {{{integration/connector.html#Extending_the_Connector}Extending the Connector}}. | +*-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ +| connector.userPathBuilderImpl | | any class implementing the | Providing a custom function to construct an user depended 'BaseDir' for the | +| | | {{{java-core/apidocs/net/fckeditor/requestcycle/UserPathBuilder.html}<<>>}} | Browser Connector. For more details see | +| | | interface | {{{integration/connector.html#Extending_the_Connector}Extending the Connector}}. | +*-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ Index: /FCKeditor.Java/branches/2.4/src/site/site.xml =================================================================== --- /FCKeditor.Java/branches/2.4/src/site/site.xml (revision 1918) +++ /FCKeditor.Java/branches/2.4/src/site/site.xml (revision 1919) @@ -35,5 +35,5 @@ />