Changeset 1981

Show
Ignore:
Timestamp:
2008-05-10 15:43:58 (5 months ago)
Author:
mosipov
Message:

Vastly improved doc

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

Legend:

Unmodified
Added
Removed

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

    r1980 r1981  
    3737   
    3838  This documentation is straight forward to use!\ 
    39   Start with {{{whatsnews.html}What's New}} to see what has changed since 2.3 and 
     39  Start with {{{whatsnew.html}What's New}} to see what has changed since 2.3 and 
    4040  there is a lot! Go over and checkout the {{{demo.html}Demo}} and if you are  
    4141  ready to deploy the FCKeditor in your webapp follow the  

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

    r1974 r1981  
    144144    [Attention:] Do <not> skip this section otherwise your application will <<fail>>! 
    145145 
    146   We use the state-of-the-art logging facade <<<slf4j>>>. To make slf4j work at runtime,  
     146  We use the state-of-the-art logging facade <<<SLF4J>>>. To make SFL4J work at runtime,  
    147147  you have to add <<one>> binding and the appropriate  backend (may be optional) into  
    148148  your classpath.\ 
    149   Please check the {{{http://slf4j.org}slf4j website}} for more information on bindings 
     149  Please check the {{{http://slf4j.org}SLF4J website}} for more information on bindings 
    150150  and the API itself. 

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

    r1936 r1981  
    2424Overview 
    2525 
    26   The Java integration pack is composed of two main components: 
     26  The Java integration pack consists of two main components: 
    2727   
    28   * The JSP-Tag-Library, for an easy integration of the FCKeditor in your JSP-pages. 
     28  * <<JSP tag library>>: Easy integration of the FCKeditor in your JSPs. 
    2929     
    30   * The Connector, a servlet to manage the handling with resource files like images. 
     30  * <<Connector>>: A servlet to manage resources like images, documents, and other files. 
    3131   
    3232  [] 
    3333   
    34   To use the JSP-Tag-Library you just have to put the main jar and dependent libraries 
    35   in your classpath. If you want to use the Connector 1.) you have to add some entries in 
    36   your <<<web.xml>>> and 2.) you have to make sure that some special properties are set. 
    37   For details have a look at {{{connector.html}Connector}} and  
    38   {{{installation.html}Installation}}. 
     34  Please read the integration parts carefully! Both the tag library and the connector 
     35  have been completely restructured. 
    3936   
    40   We introduced a new properties handling (in comparison to 2.3). You have two ways to set  
    41   the default properties of the integration pack: 
    42    
    43   * Using a common Java properties file or 
    44    
    45   * using some static setters. 
    46    
    47   [] 
    48    
    49   For a closer look see {{{connector.html}Connector}}. 
    50    
    51   This new properties handling will give you the most flexibility to integrate FCKeditor  
    52   in your Java-based web-application. 

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

    r1980 r1981  
    129129*-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ 
    130130| connector.fullUrl                     | false                          | true, false (boolean)           | Indicates whether the server url will be prepended.| 
    131 |                                                               |                                                                |                                                         | I.e. appending http://www.yourdomain.com/                  | 
     131|                                                               |                                                                |                                                         | I.e. prepending http://www.yourdomain.com/                 | 
    132132*-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ 
    133133| connector.secureImageUploads  |true                                                    | true, false (boolean)           | Checks uploaded images for validity.                               | 

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

    r1936 r1981  
    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$ 
     20                                    ------------------------------ 
     21                                                                                                What's New 
     22                                    ------------------------------ 
    2023 
    21 What's new 
    2224 
    23   This is a short overview about the changes in comparison to version 2.3: 
    24    
    25   * {{{http://dev.fckeditor.net/wiki/ServerSideStatus}The serversite intergration status}}  
    26   is completely fullfilled. 
    27    
    28   * The base package path has changed from <<<com.fredck.FCKeditor>>> to <<<net.fckeditor>>>. 
    29    
    30   * Removed SimpleUploaderServlet, the functionality has moved to ConnectorServlet. 
    31    
    32   * New properties handling:  
    33    
    34     * No properties settings in the web.xml. 
    35      
    36     * To set the properties, a common properties file or static setter methods can be used. 
    37      
    38     * All properties are optional. In the meaning of 'Convention over Configuration'  
    39     only the properties, of which the default isn't requested, have to be set. 
    40     
    41   * Introduced slf4j, a logging framework especially for 3rd-party-tools. 
    42    
    43   * Introduced 'SessionData', an interface to provide session or request-based functionality. 
    44   E.g. one function is for building a user-based 'BaseDir'. 
    45    
    46   * The JSP-Tag-Library is partially restructured. Be aware before updating and refere the  
    47   {{{taglibrary.html}tag library}} and the {{{java-core/tagreference.html}tag reference}}. 
    48    
    49   * A lot of code improvements. 
    50    
    51   * The integration pack is now managed by maven. 
     25What's New 
     26 
     27  The FCKeditor.Java integeration version 2.4 is a complete rewrite of the last 
     28  version.\ 
     29  This is a short overview about the changes since version 2.3: 
     30 
     31  * The integration pack is now managed by Maven 2 with a complete documentation 
     32    and reports. 
     33 
     34  * The libraray runs now from Servlet 2.4/JSP 2.0 and above. 
     35 
     36  * A complete structure and package review has been done. Base moved from 
     37    <<<com.fredck.FCKeditor>>> to <<<net.fckeditor>>>. 
     38 
     39  * The {{{http://dev.fckeditor.net/wiki/ServerSideStatus}Server Site Intergration}} 
     40    requirements are completely fullfilled. 
     41 
     42  * The SimpleUploaderServlet functionality has been merged into the ConnectorServlet. 
     43 
     44  * The JSP tag library has been completely restructured. 
     45 
     46  * A more complete and reliable browser detection code. 
     47 
     48  * New configuration handling: 
     49 
     50    * No configuration settings in the <<<web.xml>>> anymore. 
     51 
     52    * The configuration properties can be set in a file or dynamically as in 
     53      every other connector implementation. 
     54 
     55    * Default configuration properties are automatically set for you. 
     56 
     57  * Introduced the state-of-the-art {{{http://www.slf4j.org}SLF4J}} logging facade. 
     58 
     59  * A pluggable <<<SessionData>>> interface system has beeen introduced. This system 
     60    provides session or request-based functionality. 
     61 
     62  * Automatic creation of release distribution files (assemblies). 
     63 
     64  * JUnit test coverage on viable classes. 
     65 
     66  * Clean and safe parameter handling and abstraction. 
     67 
     68  * A lot of code performance improvements and tweaks.