Changeset 1931
- Timestamp:
- 2008-04-20 23:44:14 (3 months ago)
- Location:
- FCKeditor.Java/branches/2.4/src/site/apt
- Files:
-
- 4 modified
-
installation.apt (modified) (7 diffs)
-
integration/connector.apt (modified) (3 diffs)
-
integration/taglibrary.apt (modified) (2 diffs)
-
properties.apt (modified) (3 diffs)
Legend:
- Unmodified
- Added
- Removed
-
FCKeditor.Java/branches/2.4/src/site/apt/installation.apt
r1900 r1931 24 24 Installation Guide 25 25 26 * Using Maven 26 * Using Maven 2 27 27 28 28 [Attention:] The integration pack will be available on the central repo … … 30 30 location will be obsolete! 31 31 32 I f you use Maven 2 for your projects all you need to do is include a reference33 to the library in the dependencies section ofyour POM:32 Include a dependency reference to the library in the dependencies section of 33 your POM: 34 34 35 35 +-------------------------------------------------------+ … … 61 61 * Manual installation 62 62 63 The distribution comes in three flavors, pick one that best fits your 64 environment from the {{{http://www.fckeditor.net/download}download area}}. 63 The distribution comes in three flavors, pick one from the 64 {{{http://www.fckeditor.net/download}download area}} which fits best in your 65 environment. 65 66 66 67 * <<<fckeditor-java-core-2.4-beta-1.jar>>> … … 72 73 73 74 If you are starting from scratch, this distribution fits best. This package 74 comes with a pre-built jar and all dependencies. 75 comes with pre-built jars, all dependencies, the entire documentation for 76 offline usage and the license file. 75 77 76 Th ose distribution files are:78 The pre-built jars are: 77 79 78 80 *--------------------------------------------+----------------------------------+ 79 81 || File || Description || 80 82 *--------------------------------------------+----------------------------------+ 81 | fckeditor-java- 2.4-core-beta-1.jar | main jar|83 | fckeditor-java-core-2.4-beta-1.jar | main jar | 82 84 *--------------------------------------------+----------------------------------+ 83 | fckeditor-java- 2.4-core-beta-1-javadoc.jar| optional javadoc for IDE integration |85 | fckeditor-java-core-2.4-beta-1-javadoc.jar | optional javadoc for IDE integration | 84 86 *--------------------------------------------+----------------------------------+ 85 87 … … 93 95 | commons-io-1.3.2.jar | Apache Commons IO library | 94 96 *--------------------------------------------+----------------------------------+ 95 | slf4j-api-1.5.0.jar | simple logging facade api|97 | slf4j-api-1.5.0.jar | Simple logging facade library | 96 98 *--------------------------------------------+----------------------------------+ 97 99 … … 101 103 * <<<fckeditor-java-2.4-beta-1-src.zip>>> 102 104 103 If you want to check out the pack's core, refit the codeto your needs104 (obeying the license terms) or compile ityourself, this is the perfect105 If you want to check out the integration's source code, refit to your needs 106 (obeying the license terms) or compile yourself, this is the perfect 105 107 distribution for you. 106 108 … … 109 111 A word on Logging 110 112 111 [Attention:] Do <not> skip this section otherwise your application will <<fail !>>113 [Attention:] Do <not> skip this section otherwise your application will <<fail>>! 112 114 113 115 We use the state-of-the-art logging facade <<<slf4j>>>. To make slf4j work at runtime, 114 you have to add <<one>> binding and the appropriate backend (may be optional) onto116 you have to add <<one>> binding and the appropriate backend (may be optional) into 115 117 your classpath.\ 116 118 Please check the {{{http://slf4j.org}slf4j website}} for more information on bindings -
FCKeditor.Java/branches/2.4/src/site/apt/integration/connector.apt
r1917 r1931 81 81 82 82 The fully-qualified class name of the implemented classes can now be set as described in 83 {{{ fckeditor-properties.html}Configuration settings}}.83 {{{../properties.html}Configuration settings}}. 84 84 85 85 At the moment, the integration pack provides two interfaces to extend the connector: 86 86 87 [[1]] {{{ java-core/apidocs/net/fckeditor/requestcycle/UserPathBuilder.html}<<<net.fckeditor.requestcycle.UserPathBuilder>>>}}87 [[1]] {{{../java-core/apidocs/net/fckeditor/requestcycle/UserPathBuilder.html}<<<net.fckeditor.requestcycle.UserPathBuilder>>>}} 88 88 89 89 In this interface there is only one method <<<getUserFilesPath(final HttpServletRequest request)>>>, … … 91 91 the path for all resource files. 92 92 93 [[2]] {{{ java-core/apidocs/net/fckeditor/requestcycle/UserAction.html}<<<net.fckeditor.requestcycle.UserAction>>>}}93 [[2]] {{{../java-core/apidocs/net/fckeditor/requestcycle/UserAction.html}<<<net.fckeditor.requestcycle.UserAction>>>}} 94 94 95 95 There are two methods to authorize users to do file based actions: … … 102 102 103 103 For those who wants to enable all users for browsing and uploading files, there is an implementation 104 of <<<UserAction>>> you can use: {{{ java-core/apidocs/net/fckeditor/requestcycle/impl/UserActionImp.html}UserActionImpl}}104 of <<<UserAction>>> you can use: {{{../java-core/apidocs/net/fckeditor/requestcycle/impl/UserActionImpl.html}UserActionImpl}} -
FCKeditor.Java/branches/2.4/src/site/apt/integration/taglibrary.apt
r1900 r1931 24 24 Tag library 25 25 26 De fine the tag extension in each JSP page that uses the FCKeditor.Java taglib.27 The uri directive s must match the URI defined in the tld in the jar file.26 Declare the tag extension in each JSP page that uses the FCKeditor.Java taglib. 27 The uri directive must match the uri defined in the {{{../java-core/tagreference.html}tag reference}}. 28 28 The prefix identifies the tags in the tag library within the JSP page. 29 29 … … 39 39 +--------------------------------------------------------------------+ 40 40 41 Now you are set to use the taglib. A brief usagewould be:41 Now you are set to use the taglib. A brief declaration would be: 42 42 43 43 +--------------------------------------------------------------------+ -
FCKeditor.Java/branches/2.4/src/site/apt/properties.apt
r1919 r1931 72 72 || || || || || 73 73 *------------------------------------+--------------------------------+-----------------------------+-----------------------------------+ 74 | 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 . |74 | 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 to load. | 75 75 *------------------------------------+--------------------------------+-----------------------------+-----------------------------------+ 76 76 | fckeditor.width | 200 | any string | Indicates the editor width. | … … 84 84 * Connector 85 85 86 The integration packsupports file, flash, image, and media resource types.86 The integration library supports file, flash, image, and media resource types. 87 87 Replace <type name> in the property name with "file", "flash", "image", or 88 88 "media". … … 131 131 *-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ 132 132 | connector.secureImageUploads |true | true, false (boolean) | Checks uploaded images for validity. | 133 | | | | I.e. the uploaded file is a real image not any|133 | | | | I.e. the uploaded file is a real image and not any | 134 134 | | | | other renamed file type. | 135 135 *-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ 136 136 | connector.userActionImpl | | any class implementing the | Providing custom security functions for the File | 137 137 | | | {{{java-core/apidocs/net/fckeditor/requestcycle/UserAction.html}<<<net.fckeditor.requestcycle.UserAction>>>}} | Browser Connector. For more details see | 138 | | | interface | {{{integration/connector.html#Extending_the_Connector} Extending the Connector}}. |138 | | | interface | {{{integration/connector.html#Extending_the_Connector}here}}. | 139 139 *-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ 140 | connector.userPathBuilderImpl | | any class implementing the | Providing a custom function to construct a n user depended 'BaseDir' for the |141 | | | {{{java-core/apidocs/net/fckeditor/requestcycle/UserPathBuilder.html}<<<net.fckeditor.requestcycle.UserPathBuilder>>>}} | Browser Connector. For more details see |142 | | | interface | {{{integration/connector.html#Extending_the_Connector} Extending the Connector}}. |140 | connector.userPathBuilderImpl | | any class implementing the | Providing a custom function to construct a user-dependent 'UserFilesPath' for the | 141 | | | {{{java-core/apidocs/net/fckeditor/requestcycle/UserPathBuilder.html}<<<net.fckeditor.requestcycle.UserPathBuilder>>>}} | File Browser Connector. For more details see | 142 | | | interface | {{{integration/connector.html#Extending_the_Connector}here}}. | 143 143 *-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+
