Changeset 1780

Show
Ignore:
Timestamp:
2008-03-23 02:01:54 (8 months ago)
Author:
mosipov
Message:

Vastly improved installation doc

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • FCKeditor.Java/branches/2.4/src/site/apt/installation.apt

    r1769 r1780  
    1                                                                         ------------------------------ 
    2                                                 Installation Guide 
    3                                     ------------------------------ 
     1                                                ------------------------------ 
     2                                Installation Guide 
     3                        ------------------------------ 
    44 
    55Installation Guide 
    66 
    7   * depedend libs 
     7*       Using Maven 
     8         
     9                [Note:] The integration pack will be available on the central repo after  
     10                                it has gone gold, the additional repository location will be from 
     11                                there on obosolete! 
     12                 
     13        If you use Maven 2 for your projects all you need to do is including a  
     14        reference to library in the dependencies section of your POM: 
     15         
     16+-------------------------------------------------------+ 
     17<project> 
     18  ... 
     19  <repositories> 
     20    <repository> 
     21      <releases> 
     22        <enabled>true</enabled> 
     23      </releases> 
     24      <id>fckeditor-java-releases</id> 
     25      <name>FCKeditor Releases</name> 
     26      <url>http://www.fckeditor.net/m2repo</url> 
     27     <layout>default</layout> 
     28     </repository> 
     29  </repositories> 
     30  ... 
     31  <dependencies> 
     32    <dependency> 
     33      <groupId>net.fckeditor</groupId> 
     34      <artifactId>fckeditor-java</artifactId> 
     35      <version>2.4-beta-1</version> 
     36    </dependency> 
     37  </dependencies> 
     38  ... 
     39</project>  
     40+-------------------------------------------------------+ 
     41 
     42*       Manual installation 
     43 
     44        The distribution comes in three flavors, grab one from the {{{http://www.fckeditor.net/download}download area}}  
     45        which fits best for your evironment. 
     46         
     47        [[1]] <<<fckeditor-java-2.4-beta-1.jar>>> 
     48                   
     49                  If you already have all dependencies on your classpath, simply put this 
     50                  jar on your classpath (usually <<<WEB-INF/lib>>>) and you are ready to go. 
     51         
     52        [[2]] <<<fckeditor-java-2.4-beta-1-bin.zip>>> 
     53                   
     54                  If you are starting from the scratch, this distribution fits best. 
     55                  This package comes with a pre-built jar and all dependencies. 
     56                   
     57                  Those distribution files are: 
     58 
     59*--------------------------------------------+----------------------------------+ 
     60|| file                                      || description                    || 
     61*--------------------------------------------+----------------------------------+ 
     62| fckeditor-java-2.4-beta-1.jar              | main jar                                                 | 
     63*--------------------------------------------+----------------------------------+ 
     64| fckeditor-java-2.4-beta-1-sources.jar      | optional sources for IDE integration | 
     65*--------------------------------------------+----------------------------------+ 
     66| fckeditor-java-2.4-beta-1-javadoc.jar      | optional javadoc for IDE integration | 
     67*--------------------------------------------+----------------------------------+ 
     68                   
     69                  The <<<lib>>> folder contains following dependencies: 
     70 
     71*--------------------------------------------+----------------------------------+ 
     72|| file                                      || description                    || 
     73*--------------------------------------------+----------------------------------+ 
     74| commons-fileupload-1.2.jar                 | Apache Commons FileUpload library| 
     75*--------------------------------------------+----------------------------------+ 
     76| commons-io-1.3.2.jar                       | Apache Commons IO library        | 
     77*--------------------------------------------+----------------------------------+ 
     78| slf4j-api-1.4.3.jar                        | simple logging facade (wrapper)  | 
     79*--------------------------------------------+----------------------------------+ 
     80| slf4j-nop-1.4.3.jar (optional)             | dummy logging backend            | 
     81*--------------------------------------------+----------------------------------+ 
     82 
     83                  Drop the main jar and the dependencies in your classpath (usually  
     84                  <<<WEB-INF/lib>>>) and you are ready to go. 
     85                   
     86        [[3]] <<<fckeditor-java-2.4-beta-1-src.zip>>> 
     87                   
     88                  The text goes here... 
     89 
    890   
    9   * where to copy the jars 
    10    
    11   * entries for web.xml