Changeset 1972

Show
Ignore:
Timestamp:
2008-05-09 11:29:44 (2 months ago)
Author:
mosipov
Message:

Improved doc

Location:
FCKeditor.Java/branches/2.4/src/site/apt
Files:
2 modified

Legend:

Unmodified
Added
Removed

  • FCKeditor.Java/branches/2.4/src/site/apt/connector.apt

    r1938 r1972  
    11~~ FCKeditor - The text editor for Internet - http://www.fckeditor.net 
    22~~ Copyright (C) 2003-2008 Frederico Caldeira Knabben 
    3 ~~  
     3~~ 
    44~~ == BEGIN LICENSE == 
    5 ~~  
     5~~ 
    66~~ Licensed under the terms of any of the following licenses at your 
    77~~ choice: 
    8 ~~  
     8~~ 
    99~~  - GNU General Public License Version 2 or later (the "GPL") 
    1010~~    http://www.gnu.org/licenses/gpl.html 
    11 ~~  
     11~~ 
    1212~~  - GNU Lesser General Public License Version 2.1 or later (the "LGPL") 
    1313~~    http://www.gnu.org/licenses/lgpl.html 
    14 ~~  
     14~~ 
    1515~~  - Mozilla Public License Version 1.1 or later (the "MPL") 
    1616~~    http://www.mozilla.org/MPL/MPL-1.1.html 
    17 ~~  
     17~~ 
    1818~~ == END LICENSE == 
    1919~~ @version $Id$ 
    … …  
    2727  interaction, you can skip this section. 
    2828 
    29     [Hint:] The Connector by default is not present and disabled for security  
     29    [Hint:] The Connector by default is not present and disabled for security 
    3030            reasons! 
    3131 
    … …  
    5656 
    5757  Assuming you installed the editor in the <<</fckeditor>>> folder in your webapp.\ 
    58   The Connector is now declared but <still> disabled. The response is going to  
     58  The Connector is now declared but <still> disabled. The response is going to 
    5959  be an error message. 
    6060 
    … …  
    7171Extending the Connector 
    7272 
    73     [Hint:]  Skip this section if you are not interested in extending the  
     73    [Hint:]  Skip this section if you are not interested in extending the 
    7474             Connector. 
    7575 
    7676  The basic idea of extending the Connector is to provide some interfaces for special user depended interactions, 
    7777  which can be implemented by the developer of a webapp. All methods get the <<<HttpServletRequest>>>-object, 
    78   so the developer could identify the user with a session attribute for example and return a user  
    79   specific value. We intentionally make no suggestions how to do this, so you have the free of choice to  
     78  so the developer could identify the user with a session attribute for example and return a user 
     79  specific value. We intentionally make no suggestions how to do this, so you have the free of choice to 
    8080  implement whatever and however you like. 
    81     
    82   The fully-qualified class name of the implemented classes can now be set as described in  
     81 
     82  The fully-qualified class name of the implemented classes can now be set as described in 
    8383  {{{properties.html}Configuration settings}}. 
    84    
     84 
    8585  At the moment, the integration pack provides two interfaces to extend the connector: 
    86    
     86 
    8787  [[1]] {{{java-core/apidocs/net/fckeditor/requestcycle/UserPathBuilder.html}<<<net.fckeditor.requestcycle.UserPathBuilder>>>}} 
    88    
    89   In this interface there is only one method <<<getUserFilesPath(final HttpServletRequest request)>>>,  
    90   return value is a string. There you can implement a user dependent construction of the 'BaseDir' path,  
    91   the path for all resource files.  
    92    
     88 
     89  In this interface there is only one method <<<getUserFilesPath(final HttpServletRequest request)>>>, 
     90  return value is a string. There you can implement a user dependent construction of the 'BaseDir' path, 
     91  the path for all resource files. 
     92 
    9393  [[2]] {{{java-core/apidocs/net/fckeditor/requestcycle/UserAction.html}<<<net.fckeditor.requestcycle.UserAction>>>}} 
    94    
     94 
    9595  There are two methods to authorize users to do file based actions: 
    96    
     96 
    9797  * <<<#isEnabledForFileUpload(HttpServletRequest)>>> Enables/disables the user for uploading files. 
    98    
     98 
    9999  * <<<#isEnabledForFileBrowsing(HttpServletRequest)>>> Enables/disables the user for browsing files. 
    100    
     100 
    101101  [] 
    102    
     102 
    103103  For those who wants to enable all users for browsing and uploading files, there is an implementation 
    104104  of <<<UserAction>>> you can use: {{{java-core/apidocs/net/fckeditor/requestcycle/impl/UserActionImpl.html}UserActionImpl}} 

  • FCKeditor.Java/branches/2.4/src/site/apt/demo.apt

    r1970 r1972  
    2525   
    2626  The demo is intended for novices, beginners and for everyone who wants to see 
    27   the FCKeditor in action right out of the box. It's also a good reference for  
    28   you to see how all integral parts work together. 
     27  the FCKeditor (version 2.6) in action right out of the box. It's also a good  
     28  reference for you to see how all integral parts work together. 
    2929 
    3030  It takes two simple steps to see the demo in action: