Menu
▾
▴
[FCKeditor-Commits] r2809 - FCKeditor.Java/trunk/src/site/apt
|
From: <com...@fc...> - 2008-12-25 16:10:16
|
Author: mosipov Date: 2008-12-25 17:10:09 +0100 (Thu, 25 Dec 2008) New Revision: 2809 Modified: FCKeditor.Java/trunk/src/site/apt/localization.apt FCKeditor.Java/trunk/src/site/apt/upgrade_notes.apt.vm FCKeditor.Java/trunk/src/site/apt/useraction.apt Log: - Fixed typos - extended docs Modified: FCKeditor.Java/trunk/src/site/apt/localization.apt =================================================================== --- FCKeditor.Java/trunk/src/site/apt/localization.apt 2008-12-24 07:53:06 UTC (rev 2808) +++ FCKeditor.Java/trunk/src/site/apt/localization.apt 2008-12-25 16:10:09 UTC (rev 2809) @@ -1,82 +1,91 @@ -~~ 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$ - ------------------------- - Localization - ------------------------- - -Localization - - The integration pack offers you the capability to localize any string responded - to the user on a global basis and on a per-locale basis dependending on the - deployed framework/system (Request, JSTL, Struts, Spring, and other). - - Read on to see how you can refit the system to your needs: - -* The interface - - The interface {{{java-core/apidocs/net/fckeditor/localization/LocaleResolver.html}<<<net.fckeditor.localization.LocaleResolver>>>}} - contains only one method: - - * <<<Locale resolveLocale(final HttpServletRequest request)>>>: On every request - it will passed the current <<<HttpServletRequest>>> instance. It resolves the - user locale according to the underlying system or returns <<<null>>> if it - can't resolve the locale. - - [] - -** Choosing an implemenation - - You have to choose an inplemenation, either an existing or a custom one. If no - existing implemention suits your need, create your own. Implement the interface - and resolve the locale the way you want. - - Existing, ready-to-go implementations: - - * {{{java-core/apidocs/net/fckeditor/localization/impl/AcceptLanguageHeaderResolver.html}<<<net.fckeditor.localization.impl.AcceptLanguageHeaderResolver>>>}} (default): - It retrieves the first locale in the HTTP <<<Accept-Language>>> header if - availabe. - - * {{{java-core/apidocs/net/fckeditor/localization/impl/JstlResolver.html}<<<net.fckeditor.localization.impl.JstlResolver>>>}}: - The user locale will be retrieved from the session set by JSTL's <<<fmt>>> - tag or similar. - - [] - -** Declaring an implementation - - After your have chosen your desired implemenation, you have to declare it. - Put the fully-qualified class name of the implementation in your - <<<fckeditor.properies>>>: - -+------------------------------------------------------------------------------+ - localization.localeResolverImpl=<desired implementation> -+------------------------------------------------------------------------------+ - -* The strings - - [Hint:] The resolver system is fail-safe concerning localized string retrieval. - 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. - Put your globally localized strings in your <<<fckeditor.properties>>> and your - per-locale localized strings in a <<<fckeditor_\<locale\>.properties>>> file. - See the Localization chapter of the {{{properties.html}Configuration}} for a +~~ 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$ + ------------------------- + LocaleResolver Interface + ------------------------- + +Localization + + The integration pack offers you the capability to localize any string responded + to the user on a global basis and on a per-locale basis depending on the + deployed framework/system (Request, JSTL, Struts, Spring, and other). + + Read on to see how you can refit the system to your needs: + +* Rationale + + Interaction with the File Browser may cause messages responded to the user + about the state of the system from the view of the user. The messages are + hard-coded in English which is a big annoyance in an international deployment. + You can now change all of them to other defaults and localize to an arbitrary + locale of your choice. + +* The interface + + The interface {{{java-core/apidocs/net/fckeditor/localization/LocaleResolver.html}<<<net.fckeditor.localization.LocaleResolver>>>}} + contains only one method: + + * <<<Locale resolveLocale(final HttpServletRequest)>>>: On every request + it will passed the current <<<HttpServletRequest>>> instance. It resolves the + user locale according to the underlying system or returns <<<null>>> if it + can't resolve the locale. + + [] + +** Choosing an implementation + + You have to choose an implementation, either an existing or a custom one. + + Existing, ready-to-go implementations: + + * {{{java-core/apidocs/net/fckeditor/localization/impl/AcceptLanguageHeaderResolver.html}<<<net.fckeditor.localization.impl.AcceptLanguageHeaderResolver>>>}} (default): + It retrieves the first locale in the HTTP <<<Accept-Language>>> header if + available. + + * {{{java-core/apidocs/net/fckeditor/localization/impl/JstlResolver.html}<<<net.fckeditor.localization.impl.JstlResolver>>>}}: + The user locale will be retrieved from the session set by JSTL's <<<fmt>>> + tag or similar. + + [] + + If no existing implemention suits your needs, create your own. Implement the + interface and resolve the locale the way you want. + +** Declaring an implementation + + After your have chosen your desired implementation, you have to declare it. + Put the fully-qualified class name of the implementation in your + <<<fckeditor.properties>>>: + ++------------------------------------------------------------------------------+ + localization.localeResolverImpl=<desired implementation> ++------------------------------------------------------------------------------+ + +* The strings + + [Hint:] The resolver system is fail-safe concerning localized string retrieval. + 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. + Put your globally localized strings in your <<<fckeditor.properties>>> and your + per-locale localized strings in a <<<fckeditor_\<locale\>.properties>>> file. + See the Localization chapter of the {{{properties.html}Configuration}} for a string reference. \ No newline at end of file Modified: FCKeditor.Java/trunk/src/site/apt/upgrade_notes.apt.vm =================================================================== --- FCKeditor.Java/trunk/src/site/apt/upgrade_notes.apt.vm 2008-12-24 07:53:06 UTC (rev 2808) +++ FCKeditor.Java/trunk/src/site/apt/upgrade_notes.apt.vm 2008-12-25 16:10:09 UTC (rev 2809) @@ -49,7 +49,7 @@ | | will emit an appropriate log message. Consider to switch to another {{{connector.html}Connector}}. | *-------------------------------+----------------------------------------------+ | {{{${ticketUrl}/2582}2582}} | Path handling has been aligned to other connector implementations. The FullUrl property is gone ({{{faq.html#context-fullurl}FAQ}}). the UserFilesPath has slightly changed | -| | semantics and an UserFilesAbsolutePath property has beeen introduced. Please check the {{{properties.html}Configuration}} for more details. | +| | semantics and an UserFilesAbsolutePath property has been introduced. Please check the {{{properties.html}Configuration}} for more details. | *-------------------------------+----------------------------------------------+ | {{{${ticketUrl}/2580}2580}} | The implementation <<<{{{java-core/apidocs/net/fckeditor/requestcycle/impl/UserActionImpl.html}UserActionImpl}}>>> has been deprecated in favor of <<<{{{java-core/apidocs/net/fckeditor/requestcycle/impl/EnabledUserAction.html}EnabledUserAction}}>>>. Both classes are functionally equal. | *-------------------------------+----------------------------------------------+ Modified: FCKeditor.Java/trunk/src/site/apt/useraction.apt =================================================================== --- FCKeditor.Java/trunk/src/site/apt/useraction.apt 2008-12-24 07:53:06 UTC (rev 2808) +++ FCKeditor.Java/trunk/src/site/apt/useraction.apt 2008-12-25 16:10:09 UTC (rev 2809) @@ -1,98 +1,110 @@ -~~ 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$ - ------------------------- - UserAction Interface - ------------------------- - -UserAction - - The integration pack offers you to control every command execution sent by a - user through the File Browser. - - The Server Side Integration defines five different types of commands which are - mapped to three internal commands: - - * <<<GetFolders>>> and <<<GetFoldersAndFiles>>> to <<<GetResources>>> - - * <<<CreateFolder>>> to <<<CreateFolder>>> - - * <<<FileUpload>>> and <<<QuickUpload>>> to <<<FileUpload>>> - - [] - - Read on to see how you can refit the system to your needs: - -* The interface - - The interface {{{java-core/apidocs/net/fckeditor/requestcycle/UserAction.html}<<<net.fckeditor.requestcycle.UserAction>>>}} - contains three method of which each one is passed the current <<<HttpServletRequest>>> - instance on every request: - - * <<<boolean isCreateFolderEnabled(final HttpServletRequest request)>>>: - It determines wether the current request/user is enabled to create folders - on the server. - - * <<<boolean isEnabledForFileBrowsing(final HttpServletRequest request)>>>: - It determines wether the current request/user is enabled to retrieve resources - on the server.\ - <<Attention>>: This method maps to the <<<GetResources>>> but remains - unrenamed due to compatibility reasons. It may be renamed to - <<<isGetResourcesEnabled>>> in future versions. - - * <<<boolean isEnabledForFileUpload(final HttpServletRequest request)>>>: - It determines wether the current request/user is enabled to upload files - to the server.\ - <<Attention>>: This method maps to the <<<FileUpload>>> but remains - unrenamed due to compatibility reasons. It may be renamed to - <<<isFileUploadEnabled>>> in future versions. - - [] - -** Choosing an implemenation - - You have to choose an inplemenation, either an existing or a custom one. If no - existing implemention suits your need, create your own. Implement the interface - and resolve the locale the way you want. - - Existing, ready-to-go implementations: - - * {{{java-core/apidocs/net/fckeditor/requestcycle/impl/DisabledUserAction.html}<<<net.fckeditor.requestcycle.impl.DisabledUserAction>>>}} (default): - It always returns <<<false>>> for every method. - - * {{{java-core/apidocs/net/fckeditor/requestcycle/impl/EnabledUserAction.html}<<<net.fckeditor.requestcycle.impl.EnabledUserAction>>>}}: - It always returns <<<true>>> for every method. - - [] - -** Declaring an implementation - - After your have chosen your desired implemenation, you have to declare it. - Put the fully-qualified class name of the implementation in your - <<<fckeditor.properies>>>: - -+------------------------------------------------------------------------------+ - connector.userActionImpl=<desired implementation> -+------------------------------------------------------------------------------+ - -* User response - - The system will respond messages to the user as they may be necessary. You can - localized every one of them. See {{{properties.html}Configuration}} and +~~ 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$ + ------------------------- + UserAction Interface + ------------------------- + +User Action + + The integration pack offers you control over every command sent by a user + through the File Browser. + + Read on to see how you can refit the system to your needs: + +* Rationale + + Throughout the life cycle of the File Browser, several commands are sent with + payload to retrieve and create objects on the server. The Connector Servlet + receives the commands and responds as necessary to them. You are now able to + intercept the commands and tell the Connector Servlet if the current request + is actually enabled to perform this command on the server.\ + The {{{http://docs.fckeditor.net/FCKeditor_2.x/Developers_Guide/Server_Side_Integration#The_Commands}Server Side Integration}} + defines five different types of commands for the File Browser which are + mapped to three internal commands: + + * <<<GetFolders>>> and <<<GetFoldersAndFiles>>> to <<<GetResources>>> + + * <<<CreateFolder>>> to <<<CreateFolder>>> + + * <<<FileUpload>>> and <<<QuickUpload>>> to <<<FileUpload>>> + + [] + + Based on these commands you can mandate globally and/or on per-user basis which + commands will be executed. + +* The interface + + The interface {{{java-core/apidocs/net/fckeditor/requestcycle/UserAction.html}<<<net.fckeditor.requestcycle.UserAction>>>}} + contains three method of which each one is passed the current <<<HttpServletRequest>>> + instance on every request: + + * <<<boolean isCreateFolderEnabled(final HttpServletRequest)>>>: + Determines whether the current request/user is enabled to create folders + on the server. + + * <<<boolean isEnabledForFileBrowsing(final HttpServletRequest)>>>: + Determines whether the current request/user is enabled to retrieve resources + on the server.\ + <<Attention>>: This method maps to the <<<GetResources>>> but remains + unrenamed due to compatibility reasons. It may be renamed to + <<<isGetResourcesEnabled>>> in future versions. + + * <<<boolean isEnabledForFileUpload(final HttpServletRequest)>>>: + Determines whether the current request/user is enabled to upload files + to the server.\ + <<Attention>>: This method maps to the <<<FileUpload>>> but remains + unrenamed due to compatibility reasons. It may be renamed to + <<<isFileUploadEnabled>>> in future versions. + + [] + +** Choosing an implementation + + You have to choose an implementation, either an existing or a custom one. + + Existing, ready-to-go implementations: + + * {{{java-core/apidocs/net/fckeditor/requestcycle/impl/DisabledUserAction.html}<<<net.fckeditor.requestcycle.impl.DisabledUserAction>>>}} (default): + It always returns <<<false>>> for every method. + + * {{{java-core/apidocs/net/fckeditor/requestcycle/impl/EnabledUserAction.html}<<<net.fckeditor.requestcycle.impl.EnabledUserAction>>>}}: + It always returns <<<true>>> for every method. + + [] + + If no existing implementation suits your needs, create your own. Implement the + interface and resolve the locale the way you want. + +** Declaring an implementation + + After your have chosen your desired implementation, you have to declare it. + Put the fully-qualified class name of the implementation in your + <<<fckeditor.properties>>>: + ++------------------------------------------------------------------------------+ + connector.userActionImpl=<desired implementation> ++------------------------------------------------------------------------------+ + +* User response + + The system will respond messages to the user as they may be necessary. You can + localized every one of them. See {{{properties.html}Configuration}} and {{{localization.html}Localization}} for more details. \ No newline at end of file |