Changeset 2521

Timestamp:

10/04/08 00:09:38 (5 years ago)

Author:

mosipov

Message:

Improved documentation

Location:

FCKeditor.Java/trunk/src/site

Files:

• apt/connector.apt (modified) (1 diff)
• apt/ext_overview.apt (modified) (1 diff)
• apt/localization.apt (modified) (1 diff)
• apt/properties.apt (modified) (4 diffs)
• apt/useraction.apt (added)
• apt/userpathsbuilder.apt (added)
• site.xml (modified) (1 diff)

FCKeditor.Java/trunk/src/site/apt/connector.apt

@@ -68 +68 @@
 
   The Connector is now enabled.
-
-  >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
-Extending the Connector
-
-    [Hint:]  Skip this section if you are not interested in extending the
-             Connector.
-
-  The basic idea of extending the Connector is to provide interfaces for
-  user-dependent interactions which can be implemented by the web application
-  developer. All methods are passed the current <<<HttpServletRequest>>> instance
-  in order to retrieve request and/or session attributes to assemble a user-specific
-  return value. We intentionally do not impose any constraints or indorse any
-  particular implementation approach to give you the freedom to implement the
-  interfaces the way it fits best in your environment.
-
-  Supply the fully-qualified class names of the implementing classes as described
-  in the {{{properties.html}configuration settings}}.
-
-  Right now, the integration pack provides two interfaces to extend the Connector:
-
-  [[1]] {{{java-core/apidocs/net/fckeditor/requestcycle/UserPathBuilder.html}<<<net.fckeditor.requestcycle.UserPathBuilder>>>}}
-
-        This interface consists only of one method <<<String getUserFilesPath(final HttpServletRequest)>>>.
-        You are able to construct a user-dependent <<<UserFilesPath>>>, e.g.
-        <<</userfiles/johndoe>>>.
-
-  [[2]] {{{java-core/apidocs/net/fckeditor/requestcycle/UserAction.html}<<<net.fckeditor.requestcycle.UserAction>>>}}
-
-        There are two methods to authorize users to do file-based actions:
-
-        * <<<boolean isEnabledForFileBrowsing(final HttpServletRequest)>>> denoting
-          the user's ability to browse files on the server.
-
-        * <<<boolean isEnabledForFileUpload(final HttpServletRequest)>>> denoting
-          the user's ability to upload files to the server.
-
-        []
-
-        For those who want to enable all users to browse and upload files, there 
-        is a ready-to-use implementation <<<{{{java-core/apidocs/net/fckeditor/requestcycle/impl/UserActionImpl.html}UserActionImpl}}>>>.
-
-  []
-  >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>

FCKeditor.Java/trunk/src/site/apt/ext_overview.apt

@@ -33 +33 @@
     File Browser.
 
-  * <<UserPathBuilder>>: Enables you to construct a user-dependent file path.
+  * <<UserPathsBuilder>>: Enables you to construct a user-dependent file path.
 
   * <<Localization>>: Enables you to localize any message returned by tags and

FCKeditor.Java/trunk/src/site/apt/localization.apt

@@ -73 +73 @@
 
     [Hint:] The resolver system is fail-safe concerning localized string retrieval.
-            This means that if a localized cannot be found, the default string
-            will be used.
+            This means that if a localized string cannot be found, the default
+            string will be used.
 
   Each responded string can be localized on a global basis and on a per-locale basis.

FCKeditor.Java/trunk/src/site/apt/properties.apt

@@ -35 +35 @@
   ...
   fckeditor.toolbarSet=Basic
-  connector.userActionImpl=net.fckeditor.requestcycle.impl.UserActionImpl
+  connector.userActionImpl=net.fckeditor.requestcycle.impl.EnabledUserAction
   ...
 +------------------------------------------------------------------------------+
@@ -47 +47 @@
   PropertiesLoader.setProperty("fckeditor.toolbarSet", "Basic");
   PropertiesLoader.setProperty("connector.userActionImpl",
-                   "net.fckeditor.requestcycle.impl.UserActionImpl");
+                   "net.fckeditor.requestcycle.impl.EnabledUserAction");
   ...
 +------------------------------------------------------------------------------+
@@ -133 +133 @@
 |                                                               |                                                                                       |                                                       | other renamed file type.                                                      |
 *-------------------------------+-------------------------------------------+---------------------------+---------------------------------------------------+
-| connector.userActionImpl              | {{{java-core/apidocs/net/fckeditor/requestcycle/impl/FalseUserAction.html}<<<net.fckeditor.requestcycle. | any fully-qualified class  | Provides custom security functions for the File       |
-|                                                               | impl.FalseUserAction>>>}}                                     | name of a valid {{{java-core/apidocs/net/fckeditor/requestcycle/UserAction.html}<<<UserAction>>>}}  | Browser Connector. For more details see {{{connector.html}here}}. |
+| connector.userActionImpl              | {{{java-core/apidocs/net/fckeditor/requestcycle/impl/DisabledUserAction.html}<<<net.fckeditor.requestcycle. | any fully-qualified class       | Provides custom security functions for the File       |
+|                                                               | impl.DisabledUserAction>>>}}                                  | name of a valid {{{java-core/apidocs/net/fckeditor/requestcycle/UserAction.html}<<<UserAction>>>}}  | Browser Connector. For more details see {{{useraction.html}here}}. |
 |                                                               |                                                                                       | implementation                        |                                                                                                       |
 *-------------------------------+-------------------------------------------+---------------------------+---------------------------------------------------+
 | connector.userPathBuilderImpl | {{{java-core/apidocs/net/fckeditor/requestcycle/impl/ContextPathBuilder.html}<<<net.fckeditor.requestcycle. | any fully-qualified class       | Provides a custom function for constructing a user-dependent <<<UserFilesPath>>> for the File |
-|                                                               | impl.ContextPathBuilder>>>}}                          | name of a valid {{{java-core/apidocs/net/fckeditor/requestcycle/UserPathBuilder.html}<<<UserPathBuilder>>>}} | Browser Connector. For more details see {{{connector.html}here}}. |
+|                                                               | impl.ContextPathBuilder>>>}}                          | name of a valid {{{java-core/apidocs/net/fckeditor/requestcycle/UserPathBuilder.html}<<<UserPathBuilder>>>}} | Browser Connector. For more details see {{{userpathsbuilder.html}here}}. |
 |                                                               |                                                                                       | implementation                        |                                                                                                       |
 *-------------------------------+-------------------------------------------+---------------------------+---------------------------------------------------+
@@ -150 +150 @@
 || Property                                                     || Default                                                                      || Valid Values || Description                                     ||
 *-----------------------------------+-------------------------------------------+---------------+---------------------------------------------------+
-| localization.localeResolverImpl       | {{{java-core/apidocs/net/fckeditor/localization/impl/AcceptLanguageHeaderResolver.html}<<<net.fckeditor.localization.impl. | any fully-qualified class | Provides localization capabilites for the integration pack. For more details see {{{i18n.html}here}}. |
+| localization.localeResolverImpl       | {{{java-core/apidocs/net/fckeditor/localization/impl/AcceptLanguageHeaderResolver.html}<<<net.fckeditor.localization.impl. | any fully-qualified class | Provides localization capabilites for the integration pack. For more details see {{{localization.html}here}}. |
 |                                                                       | AcceptLanguageHeaderResolver>>>}}                     | name of a valid {{{java-core/apidocs/net/fckeditor/localization/LocaleResolver.html}<<<LocaleResolver>>>}} |  |
 |                                                                       |                                                                                       | implementation|                                                                                                       |

FCKeditor.Java/trunk/src/site/site.xml

@@ -35 +35 @@
                 <menu name="Extending the Library">
                         <item name="Overview" href="/ext_overview.html"/>
-                        <item name="UserAction" />
-                        <item name="UserPathBuilder" />
+                        <item name="UserAction" href="/useraction.html" />
+                        <item name="UserPathsBuilder" href="/userpathsbuilder.html" />
                         <item name="Localization" href="/localization.html" />
                 </menu>